/*
 * MIT License
 *
 * Copyright (c) 2023-present, tangli
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package tony.crypto

import tony.core.codec.Encoding

/**
 * 加/解密相关 provider
 * @author tangli
 * @date 2023/12/07 19:33
 */
public interface CryptoHolder {
    /**
     * 加解密算法, 目前只支持 aes/des, 默认des
     */
    public val algorithm: CryptoAlgorithm

    /**
     * 二进制编码, 默认HEX upper case.
     */
    public val encoding: Encoding
        get() = Encoding.HEX

    /**
     * 待加密的字符串或二进制的编码
     */
    public val encryptedSrcEncoding: Encoding
        get() = encoding

    /**
     * 待解密的字符串或二进制的编码
     */
    public val decryptedSrcEncoding: Encoding
        get() = encoding

    /**
     * 加密到字符串
     * @param [src] 来源
     * @return [String]
     * @author tangli
     * @date 2025/10/05 23:43
     */
    public fun encryptToString(src: CharSequence): String

    /**
     * 解密到字符串
     * @param [src] 来源
     * @return [String]
     * @author tangli
     * @date 2025/10/05 23:43
     */
    public fun decryptToString(src: CharSequence): String

    /**
     * 解密到[ByteArray]
     * @param [src] 来源
     * @return [String]
     * @author tangli
     * @date 2025/10/05 23:43
     */
    public fun decrypt(src: ByteArray): ByteArray

    /**
     * 解密到[ByteArray]
     * @param [src] 来源
     * @return [String]
     * @author tangli
     * @date 2025/10/05 23:43
     */
    public fun decrypt(src: CharSequence): ByteArray
}
